Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace frigate with helm-docs #160

Merged
merged 6 commits into from
May 22, 2024
Merged

Conversation

nineinchnick
Copy link
Member

Use pre-commit so developers can use a git hook to regenerate docs.

I replaced frigate with helm-docs because frigate's pre-commit hook requires conda to install it. helm-docs run from a Docker container.

Also update all GitHub actions and enable Dependabot.

@nineinchnick nineinchnick requested a review from mosabua May 12, 2024 09:24
@cla-bot cla-bot bot added the cla-signed label May 12, 2024
Copy link
Member

@mosabua mosabua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In principal I am good with this change .. however.. the rendered output does not show and description anymore.. I am hoping we can somehow make the docs for all the values more useful. Can we somehow fix this?

In fact I am contemplating adding a website similar to how we just got it added in the Trino Gateway repo .. so we can write some useful docs for the charts that go beyond what we have in the Trino docs themselves.

charts/trino/README.md Outdated Show resolved Hide resolved
@mosabua
Copy link
Member

mosabua commented May 13, 2024

Also .. if helm-docs is good .. we want to look at adding its usage for the Trino Gateway chart in the trino-gateway repo.

@nineinchnick nineinchnick force-pushed the update-ci branch 4 times, most recently from cb4071e to d570154 Compare May 18, 2024 15:19
@nineinchnick
Copy link
Member Author

@mosabua I've used a custom template to print all values as a definition list instead of a table. I included those large examples that wouldn't fit in the table well. I also filled in most descriptions with links to Kubernetes and Trino documentation, where relevant. Please review.

@nineinchnick nineinchnick force-pushed the update-ci branch 2 times, most recently from dd2c8f4 to 79fbcc0 Compare May 18, 2024 15:31
Copy link
Member

@mosabua mosabua left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a massive improvement. I think we should merge and then we can refine more going forward in terms of specific wording other nits in separate PRs.

@nineinchnick nineinchnick merged commit 8b05ec0 into trinodb:main May 22, 2024
8 checks passed
@nineinchnick nineinchnick deleted the update-ci branch May 22, 2024 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants